dxp-ux

billingAccount/service/{id}

[GET]

This operation gets the account details based on service number for resources with operations that allow fetching of Account Details

URL

https://[localhost]:[port]/dxp-ux/v1/{businessId}/billingAccount/service/{id}

URL PARAMS

Header

Response [ 200 ]

LCPR Success Response

This is non-tmf response, which is used to retrieve the migration status from DynamoDB.

OK - request processed successfully, response body contains an entity corresponding to the requested resource.

{
  "subscriptionId": "165682573434",
  "accountType": "B2C",
  "state": "Active",
  "recurringFlag": false,
  "fraudFlag": false,
  "pin": "3472163402",
  "migrationStatus": "success",
  "salesforceAccountNumber": "169338844735",
  "migrationETA": "testing",
  "bssSourceSystem": "Anatares"
}

Possible response error

HTTP Status response is 400

with Response

[ 400 ]

Bad Request - the request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modifications.

{
    "errors": [
        {
            "code": 400,
            "message": "APIKIT:BAD_REQUEST",
            "description": "Invalid value 'M' for uri parameter businessId. M is not a valid enum value"
        }
    ]
}

[ 401 ]

Unauthorized - The request has not been applied because it lacks valid authentication credentials for the target resource.

{
  "errors" : [{
      "code" : 401,
      "message" : "The user could not be authenticated for this request.",
      "description" : "The request has not been applied because it lacks valid authentication credentials for the target resource"
    }]
}

[ 403 ]

Forbidden - Indicates that the server understood the request but refuses to fulfill it. If authentication credentials were provided in the request, the server considers them insufficient to grant access. The client SHOULD NOT automatically repeat the request with the same credentials. The client MAY repeat the request with new or different credentials.

[ 404 ]

Not Found - server has not found a resource with that URI. This may be temporary and permanent condition. This status code is commonly used when the server does not wish to reveal exactly why the request has been refused, or when no other response is applicable.

{
    "errors": [
        {
            "code": 404,
            "message": "DYNAMO_DB :Account details not found for serviceNumber: 7872000007",
            "description": "NOACCTSFOUND-No Accounts found"
        }
    ]
}

[ 405 ]

Method Not Allowed - HTTP method not allowed for this resource. The method specified in the Request-Line is not allowed for the resource identified by the Request-URI.

{
    "errors": [
        {
            "code": 405,
            "message": "APIKIT:METHOD_NOT_ALLOWED",
            "description": "HTTP Method post not allowed for : /{businessId}/billingAccount/service/{id}"
        }
    ]
}

[ 500 ]

Internal Server Error - server encountered an error processing request. This should not happen normally, but it is a generic error message, given when no more specific message is suitable.

{
"errors" : [{
"code" : 500,
"message" : "The request failed due to an internal error.",
"description": "error description"
}]
}

[ 501 ]

Check for the other BU Flows, if not implemented then throw a standard error message as below.

{
    "errors": [
        {
            "code": 501,
            "message": "NOT IMPLEMENTED",
            "description": "Operation GET /billingAccount/service/id for Business Id: JM not implemented"
        }
    ]
}

[ 503 ]

Service Unavailable

    {
    "errors": [
        {
            "code": 503,
            "message": "HTTP:SERVICE_UNAVAILABLE",
            "description": "HTTP POST on resource 'http://0.0.0.0:9091/nontmf-biz/v1/{businessId}/customerMigrationInfo?serviceNumber' failed: service unavailable (503)."
        }
    ]
}

Definitions

TMF 666

Administration and data management

In this section you define all the transformations, temporary and final repositories of the data within the method flow.

Transformation Request

nontmf-biz

URL

http://0.0.0.0:9091/nontmf-api/v1/{businessId}/customerMigrationInfo?serviceNumber=XXXXXX

Headers

QueryParameters

Services dependencies

This section defines all the connections to the web services and the methods that are used within the method.

nontmf-biz